What's New

Invoices 3.12

Updated the identity_type and identity_value fields.

Loyalty 3.5

Added a PUT endpoint to update the primary card number for an existing Loyalty account.

Invoices 3.11

Updated the external_loyalty_programme_data.external_program_field.

Accounts Payable 3.0

Search endpoint changed from a GET to a POST.

Products 3.7

• Added a method to retrieve departments, subcategories and classes.
• Added error messaging for paging.

Common Scenarios

• Added Postman Collections.
• Added Results Paging.

Loyalty 3.4

Added a card_number field to the POST Create Loyalty Account endpoint.

Carts 3.3

New header details, pricing_set ID and set_quantity, are passed from the Web Pricing Service to the create new cart endpoint response.

Loyalty 3.3

Added a new GET Identifiers endpoint.

Products 3.6

Added alternate supplier details to the product mode.

POS Users 3.2

Encryption keys made configurable.

Loyalty Fuel CPL Discounts 3.8

• Added the ability to add a transaction note when adjusting a CPL discount.
• The API can now run in multi-line discount mode.

Stock Receipts 3.1

• New endpoints for stock transfers.
• Removed dependency on Transfers API.

POS Users 3.1

Added information about the encryption key configuration.

Automated Inventory Replenishment 3.0

Added new API.

Sales Orders 3.4

Aligned customer types to relevant fields in the sales order response.

Invoices 3.9

Added external_payment_note field.

Loyalty Prepay Accounts 3.1

Added GET endpoint to retrieve prepay account information.

Invoices 3.6

Added "set_quantity" field to automatic pricing adjustment for product sets.

Products Search 3.1

Added support for Azure Cognitive Search Services.

Invoices 3.8

POST Invoices endpoint updated.

Product Inventory 3.1

• Added POST /product_inventory/movement endpoint.
• Added POST /product_inventory/movement/search endpoint.

Inventory Adjustments 3.1

New API added.

Invoice 3.7

Modified the POST endpoint to allow fuel data to be sent.

Inventory Transfer 3.1

Added additional endpoints:

• GET /inventory_transfer/transfer_reasons
• PUT /inventory_transfer/{transfer_code}
• GET /inventory_transfer/{transfer_code}
• PUT /inventory_transfer/{transfer_code}/status
• POST /inventory_transfer/search

Loyalty 3.2

Added ability to stop fraudulent cards from being used at the POS via GET Identifiers endpoint.

Products 3.4

Added a new GET endpoint to retrieve an array of existing products.

Updated Transaction Validation Rules.

Product Inventory 3.0

Added “include_location” parameter to each endpoint.

Invoices 3.5

Added the PaymentReference field.

POS Users 3.1

• Created new POST POS User search endpoint.
• Added primary and alternative site code properties.
• Added password reset option in PUT.

Invoices 3.4

Added new field update_quantity_on_hand.

POS Users 3.0

User's date of birth added.

Carts 3.2

New pricing_mode parameter and price_state added in response to handle the RecalculateMode in the pricing engine.

Invoices 3.3

Added additional validation failure data to template capture.

Products 3.2

Removed cluster_controlled property.

Loyalty Fuel CPL Discounts 3.7

• Added a property offer_template_code in the GET customer CPL discounts response.
• Added a request parameter include_cpl_discounts and new array in response cpl_discounts of the POST transaction search endpoint.

Removed Agency Gateway and NZTA Gateway APIs.

Added the Common Scenarios section.

Product Price Lists 3.0

Modification to the Promoted Product Sets endpoint.

Carts 3.1

Fixed an inconsistent property name.

Purchase Orders 3.0

Added sales_order_allocation.

Sales Orders 3.2

Added Get Order Payments endpoint.

Loyalty Prepay Accounts 1.0.18

Added a new field prepay_transaction_code to the transaction search results.

Sales Orders 3.2

Added the dispatch_site_code field.

Infinity Fuel CPL Discounts 3.5

Targeted offers display a validity period of CPL rules.

External Loyalty Fuel CPL Discounts 3.4

• Include in the response the current balance of each loyalty account associated with the check-in with their combined balance as received from Loyalty Fuel CPL Discounts API .
• Added new logic to check check-in for an external loyalty identifier.
• Added CPL breakdown in the response for all the identifiers found in the check-in.
• Added new logic to trigger the call to LNZ Burn Reversal.
• Added an array of CPL balance breakdown in the response body.
• Updated GET Balance endpoint if CPB check-in contains a Flybuys card that is unregistered.

Invoices 3.2

Added loyalty points to the invoice header and line details.

Infinity Fuel CPL Discounts 3.5

• Targeted offers allowed for combined balances.
• Added an array of CPL balance breakdown in the response body for spend reversals with combined balances.
• Added new fields for transferred transactions to the POST Transaction Search endpoint.
• Updated logic for POST balance transfer.

Loyalty 2.0.19

Person code now an array.

Infinity Fuel CPL Discounts 3.4

• Added lifetime_savings in the response for each identifier in the associated_identifier_balances array.
• Do not reverse stacked CPL balance for the balance_transfer product.
• GET Customer CPL Discounts for additional identifiers.

External Loyalty Fuel CPL Discounts 3.3

Added lifetime_savings to the response array of associated_identifier_balances.

Carts 3.0

Carts 3.0 made the default Carts API version.

Carts 1.0.4

Infinity API Developer's Guide updated to remove obsolete events.

NZTA Gateway API 3.5

Payment advice cleaned up.

Infinity Gift Card 1.0.0

First version of the API.

External Loyalty Fuel CPL Discounts 3.2

Added external_identifier in the POST transaction search response to include the Flybuys card number for which the external Flybuys CPL balance was consumed.

Loyalty Fuel CPL Discounts 3.3

• Added CPL discountbBreakdown in the spend response.
• For combined balances check for targeted offers for associated accounts to determine the value of allowed_transactions property in the GET Balance endpoint.
• POST Save enhancements with combined balance check for the targeted CPL offers that apply to associated identifiers and apply if any applicable exist and add the offers rules in the response.

Sales Orders 1.0.18

Added payment_site and payment_user to the payments create model to enable payments to specify the user and terminal.

Loyalty Fuel CPL Discounts 3.2

Added new transaction type and transaction status to POST Transaction Search.

Loyalty Fuel CPL Discounts 3.1

Added ability to move a fuel CPL balance from one Loyalty account to another Loyalty account.

External Loyalty Fuel CPL Discounts 3.1

• Added new logic to check check-in for an external loyalty identifier.
• Added toggle option to turn on or off using external identifier by an unassociated loyalty code.
• Added CPL breakdown in the response for all of the identifiers found in the check-in.

Quotes 1.1.6

Added field unique_quote_line_id to quote_line.

External Loyalty Fuel CPL Discounts 3.0

• Allow multiple additional identifiers with GET /balance.
• Call LNZ API GET balance endpoint when the Flybuys card is added as an additional identifier or a Flybuys card is associated with checkin but is not associated with the Loyalty account.
• Create a new array of external and current balance in the response for the primary Lcode and each identifier associated with checkin and supplied as an additional identifier.

Loyalty Fuel CPL Discounts 3.0

• Added ability to accept array of associated customer identifiers.
• Added ability to search for check-in request to retrieve identifiers.
• Returns shared CPL balance.
• OAS 3.0 upgrade.

Loyalty 2.0.18

• Added new field prepay_transaction_code.
• Added new array to request that allows multiple associated identifiers to be passed.
• Added check of InfinityAPI.loyalty.account_child_accounts for the primary loyalty account of the check-in request.

Product Price List 1.0.6

• Change to structure of updated fields in response for GET Promoted Product Sets endpoint.
• Changes to response structure of price_adjustments in Promoted Product Set endpoint.

Carts 1.0.4

• Changed request field loyalty_account_code to non mandatory.
• Added new response field, extended_cost_price.
• Updated the mapping for loyalty_account_code in the response.
• Validated product codes in the create_cart request.
• Updated response properties of pricing_set and pricing_group to NULL if a single promotion is applied.

Sales Orders 1.0.16

• Removed field owner_site_code. This has been replaced by last_updated_site_code.
• sales_person_code is now mandatory.
• Updated tender_identifier maxLength to 60.

Product Price List 1.0.5

Added new request and response properties for the GET Promoted Product Sets endpoint.

Agency Gateway 3.1

First version.

Accounts Receivable 1.0.10

Added customer custom fields and extended data.

Products 3.1

Added postal services as an item type.

Accounts Receivable 1.0.9

Added POST and PUT endpoints for debtor addresses.

Sites 3.0.0

Added new site properties.

Sites 3.1

Added site_category_description to GET endpoints.

Products Planned Changes 3.0

First version.

Products 3.0

Added /product/{product_code}/ranging POST and GET endpoints.

Added selling_start_date and selling_end_date properties to the product mode.

Invoices 1.0.11

Added original invoice reference.

Invoices 1.0.9

Added a property in GET/SEARCH that returns the data captured with a data capture item type.

Invoices 1.0.8

Added new header field: sales_order_code.

Added new line field: unique_sales_order_line_id.

Sales Orders 1.0.13

Added additional fields to Create, Search and Get the Sale Order endpoint.

Accounts Receivable 1.0.8

Added external_balance field.

People 2.0.3

Added marketing communication options.

People 2.0.1

Added field length validation rules and email address validation rules.

Product Price Lists 1.0.3

Updates to GET Promoted Product Sets endpoint/

External Loyalty Fuel CPL Discounts 1.0.6

Added new properties in POST transaction search to support pagination.

Loyalty Fuel CPL Discounts 1.0.15

Added new properties in POST transaction search to support pagination.

Loyalty 2.0.17

Added loyalty_offer_identifier field in the POST /Offer request body.

Added loyalty_offer_identifier field in the GET /Offer response body.

Loyalty Prepay Accounts 1.0.16

All APIs have been upgraded to .NET core 3.1.

POS Users 1.0.1

Added post, get, put and delete endpoints.

Sales Orders 1.0.10

Added new invoice creation logic.

External Loyalty Fuel CPL Discount 1.0.5

CPL Transaction ID format change to integer where it’s still number. No functional changes.

Loyalty 2.0.14

Added new field “source_identifier”.

Loyalty Fuel CPL Discounts 1.0.14

Changed the type from number to integer and removed the format: integer for cpl_transaciton_id.

Loyalty Offer Templates 1.0.4

New number_of_customer_associations property.

Loyalty Fuel CPL Discounts 1.0.12

Balance description update, and new example.

External Loyalty Fuel CPL Discounts 1.0.4

Balance description update, and new example.

Loyalty Offer Templates 1.0.3

• Enhanced POST customer_associations endpoint to include CPL rules by branch.
• Enhanced POST customer_associations endpoint to include Loyalty Offers.
• New worker to associate customers to Loyalty Offers.
• Changed GET customer_association to retrieve data from the new table.

Loyalty Offer Templates 1.0.2

• Enhanced POST Offer_templates endpoint to add allowed_transactions in cpl_discount_rule and the include “exclusive” rule_type.
• New endpoint POST loyalty_offer_configuration to add, deactivate or re-add loyalty offer config in the offer template.
• Enhanced DELETE offer_templates endpoint to include loyalty offer config to be deactivated.
• Enhanced GET offer_templates endpoint to include loyalty offer config in the response.
• New endpoint GET loyalty_offer_configuration.

This month we've added these API versions:

External Loyalty Fuel CPL Discounts 1.0.2

Changed the CPL discounts field to reflect decimal format in the notification and GET customer_cpl_discounts.

This month we've added these API versions:

Loyalty Fuel CPL Discounts 1.0.9

Notifications have been updated to include the following:

• CPL balance: loyalty customer’s active identifiers.
• CPL spend : transaction detail and a breakdown of save CPL transactions that were spent by this transaction.

External Loyalty Fuel CPL Discounts 1.0.1

• Added a transaction_reference field in External CPL Spend Created.
• Changed the customer_cpl_discount endpoint from POST to GET to align with the Swagger.
• Added POST / Save/Reversal.
• Added POST / Spend/Reversal.

Loyalty 2.0.11

Added a new field “accumulator_rule_id” in the GET loyalty account accumulators response.

Loyalty Offer Templates 1.0.1

• Added a new validation in both POST and DELETE customer_association to only allow a request with customer_identifier CPL rule.
• Changed DELETE customer_association logic to align with POST customer_association logic.

Loyalty Fuel CPL Discounts 1.0.10

• Changed the CPL discounts field to reflect the decimal format in the notification and GET customer_cpl_discounts.
• Correct the format of the GET customer_cpl_discounts and the CPL Spend Reversed notification.

This month we've added these API versions:

Loyalty Fuel CPL Discounts 1.0.7 and 1.0.8

Each Loyalty account can have an available balance which consists of the total cents-per-litre from all the CPL rules for which it qualifies.

Loyalty Prepay Accounts 1.0.14

Added the “Reversal” transaction subtype.

Loyalty Offer Templates 1.0.0

The Loyalty Offer Templates API enables the management of offer mechanisms and associated lists of customers. An offer template is a set of different combinations of customer incentives in order to secure customer retention and attract new customers.

External Loyalty Fuel CPL Discounts 1.0.0

The External Loyalty Fuel CPL Discounts API enables external Loyalty cents-per-litre discounts to be redeemed in addition to the Loyalty cents-per-litre discounts.

This month we've added these API versions:

Loyalty 2.0.10

A new “person_code” parameter has been added to loyalty account search request body.

An identifier is now optional in a loyalty account search request body.

Stock Receipts 1.0.0 and 1.0.1

The Stock Receipts API allows you to receipt stock by means other than purchase order, invoice or transfer.